docs: Explain the shortcutcontroller example a bit
authorMatthias Clasen <mclasen@redhat.com>
Thu, 23 Jul 2020 16:43:46 +0000 (12:43 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 23 Jul 2020 22:24:18 +0000 (18:24 -0400)
Add a reference to the the syntax for shortcut actions
in builder files.

gtk/gtkshortcutcontroller.c

index 1b995f5098fb23447482ee886d898ff5c575ab3f..1d4806b198cbe11b317e469ba76a816388a48d4c 100644 (file)
@@ -50,7 +50,7 @@
  *         <property name='scope'>managed</property>
  *         <child>
  *           <object class='GtkShortcut'>
- *             <property name='trigger'>&lt;Control&gt;k</property>
+ *             <property name='trigger'><![CDATA[<Control>k]]></property>
  *             <property name='action'>activate</property>
  *           </object>
  *         </child>
  *     </child>
  *   </object>
  * ]|
+ *
+ * This example creates a #GtkActivateAction for triggering the `activate`
+ * signal of the GtkButton. See gtk_shortcut_action_parse_string() for the syntax
+ * for other kinds of #GtkShortcutAction. See gtk_shortcut_trigger_parse_string()
+ * to learn more about the syntax for triggers.
  **/
 
 #include "config.h"